/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   Aug 2, 2019 (Perla Gjoka): created
 */
package org.knime.base.data.filter.row.dialog.component;

import org.knime.core.data.DataColumnSpec;
import org.knime.core.data.DataTableSpec;
import org.knime.core.data.DataType;
import org.knime.core.data.def.LongCell;
import org.knime.core.data.def.StringCell;
import org.knime.core.util.UniqueNameGenerator;

/**
 * The role a column has in a data table.
 *
 * @author Perla Gjoka, KNIME GmbH, Konstanz, Germany
 * @author Adrian Nembach, KNIME GmbH, Konstanz, Germany
 * @since 4.1
 */
public enum ColumnRole {

    /**
     * The row id is a special column that uniquely identifies the rows in a table.
     */
    ROW_ID("RowID", StringCell.TYPE),

    /**
     * The row index is an implicit long column that provides the index of each row in the table.
     */
    ROW_INDEX("RowINDEX", LongCell.TYPE),
    /**
     * Ordinary columns are any columns a table may contain that are not the row id or the row index.
     */
    ORDINARY(null, null);

    private final String m_defaultName;
    private final DataType m_type;

    ColumnRole(final String defaultName, final DataType type) {
        m_defaultName = defaultName;
        m_type = type;
    }

    /**
     * @return default name of the additional column
     */
    public String getDefaultName() {
        return m_defaultName;
    }

    /**
     * @return type of the additional column
     */
    public DataType getType() {
        return m_type;
    }

    /**
     * @param tableSpec without the additional columns
     * @return new column spec for the additional column, making sure the name
     * is unique to avoid collisions with existing columns
     */
    public DataColumnSpec createColumnSpec(final DataTableSpec tableSpec) {
        final UniqueNameGenerator nameGen = new UniqueNameGenerator(tableSpec);
        return nameGen.newColumn(createUniqueName(tableSpec), m_type);
    }

    /**
     * @param tableSpec without the additional columns
     * @return the name of the new additional column
     */
    public String createUniqueName(final DataTableSpec tableSpec) {
        final UniqueNameGenerator nameGen = new UniqueNameGenerator(tableSpec);
        return nameGen.newName(m_defaultName);
    }

}